Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Maintenance/docs #114

Merged
merged 4 commits into from
Nov 20, 2023
Merged

Maintenance/docs #114

merged 4 commits into from
Nov 20, 2023

Conversation

Boomatang
Copy link
Contributor

  • Update docs for better rendering of dos.kaudrant.io
  • fix broken links

Verification

  • Edited markdown pages should render correctly in
    • Github
    • Docs.kuadrant,io
  • All links should work in both locations

To help with rendering these changes on the docs site, Kuadrant/docs.kuadrant.io#41 can be used to run these changes locally

All updates are to fix issue found when renedered with mkdocs on
docs.kuadrant.io
The table has being removed to favour the table of contents that is
generated by mkdocs on docs.kuadrant.io
@codecov-commenter
Copy link

Codecov Report

Merging #114 (ebad553) into main (c4945bb) will decrease coverage by 14.95%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             main     #114       +/-   ##
===========================================
- Coverage   68.80%   53.85%   -14.95%     
===========================================
  Files          14       12        -2     
  Lines         984      817      -167     
===========================================
- Hits          677      440      -237     
- Misses        267      337       +70     
  Partials       40       40               
Flag Coverage Δ
integration 66.06% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
api/v1alpha1 (u) 100.00% <ø> (ø)
pkg/helpers (u) 0.00% <ø> (∅)
pkg/log (u) 31.81% <ø> (ø)
pkg/reconcilers (u) 26.60% <ø> (-17.60%) ⬇️
pkg/limitador (u) 69.03% <ø> (-19.43%) ⬇️
controllers (i) 66.06% <ø> (ø)

see 11 files with indirect coverage changes

@@ -1,23 +1,5 @@
# Development Guide

<!--ts-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why remove the TOC? 😢

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They are generated automatically already in the docs website and by Github.

Screenshot 2023-11-10 at 15 13 00 Screenshot 2023-11-10 at 15 15 01

@Boomatang Boomatang marked this pull request as ready for review November 20, 2023 09:29
@Boomatang Boomatang merged commit a0a88c2 into Kuadrant:main Nov 20, 2023
8 checks passed
@Boomatang Boomatang deleted the maintenance/docs branch December 4, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: To test
Development

Successfully merging this pull request may close these issues.

5 participants